/***************************************************************************
 *
 * Copyright (c) 2014 Baidu, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **************************************************************************/
// Author: Wen Xiang <bigflow-opensource@baidu.com>
//

#ifndef FLUME_PLANNER_COMMON_BUILD_COMMON_EXECUTOR_PASS_H_
#define FLUME_PLANNER_COMMON_BUILD_COMMON_EXECUTOR_PASS_H_

#include <map>
#include <string>

#include "flume/planner/common/prepared_analysis.h"
#include "flume/planner/pass.h"
#include "flume/planner/pass_manager.h"

namespace baidu {
namespace flume {
namespace planner {

class Plan;
class Unit;

class BuildCommonExecutorPass : public Pass {
    RELY_PASS(BuildStreamShuffleExecutorPass);
    RELY_PASS(BuildStreamLogicalExecutorPass);
    RELY_PASS(BuildShuffleExecutorPass);
    RELY_PASS(BuildLogicalExecutorPass);
    RELY_PASS(BuildPartialExecutorPass);
    RELY_PASS(BuildCacheWriterExecutorPass);

public:
    class BuildStreamShuffleExecutorPass : public Pass {
        PRESERVE_BY_DEFAULT();
    private:
        class Impl;

        virtual bool Run(Plan* plan);
    };

    class BuildStreamLogicalExecutorPass : public Pass {
        PRESERVE_BY_DEFAULT();
    private:
        class Impl;

        virtual bool Run(Plan* plan);
    };

    class BuildShuffleExecutorPass : public Pass {
        RELY_PASS(PreparedAnalysis);
        RELY_PASS(BuildStreamShuffleExecutorPass);
        PRESERVE_BY_DEFAULT();
    private:
        class Impl;

        virtual bool Run(Plan* plan);
    };

    class BuildLogicalExecutorPass : public Pass {
        RELY_PASS(PreparedAnalysis);
        RELY_PASS(BuildStreamLogicalExecutorPass);
        PRESERVE_BY_DEFAULT();
    private:
        class Impl;

        virtual bool Run(Plan* plan);
    };

    class BuildPartialExecutorPass : public Pass {
        RELY_PASS(PreparedAnalysis);
        RELY_PASS(BuildShuffleExecutorPass);
        PRESERVE_BY_DEFAULT();
    private:
        class Impl;

        virtual bool Run(Plan* plan);
    };

    class BuildCacheWriterExecutorPass : public Pass {
        PRESERVE_BY_DEFAULT();
    private:
        class Impl;

        virtual bool Run(Plan* plan);
    };

private:
    virtual bool Run(Plan* plan) {
        return false;
    }
};

}  // namespace planner
}  // namespace flume
}  // namespace baidu

#endif // FLUME_PLANNER_COMMON_BUILD_COMMON_EXECUTOR_PASS_H_
